Fix: Version header in response Vary#1637
Open
arctic-char wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #1628.
When using
ClientSpecifiesVersionInHeader, responses can differ based on the version request header, but the server wasn't setting theVaryresponse header accordingly. Caching proxies could then serve a response cached for one API version to a client requesting another.This adds
DynamicVersionPolicy::response_vary_on()(default: none) so policies can declare which request headers affect the response.ClientSpecifiesVersionInHeaderreturns its configured header name.VersionPolicy::add_vary_headers()appends those fields toVarywithout duplicating existing entries and skips whenVary: *is already set. The server applies this to all responses (including version-policy errors) inhttp_request_handle_wrap, matching the existing gzipAccept-Encodingpattern.Testing
add_vary_on_header(basic add, no duplicate, skip onVary: *)test_versionsintegration test assertsVaryincludes the version header on success and error responsescargo test -p dropshot